/*
 * Copyright 2007 National Bioinformatics Network
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dgbgui.gui.event;

import java.util.LinkedHashSet;

import dgbgui.gui.widgets.Widget;
import dgbgui.gui.widgets.visual.QueryWidget;
import edu.umd.cs.piccolo.event.PBasicInputEventHandler;
import edu.umd.cs.piccolo.event.PInputEvent;

/**
 * @author bjnortier
 * This event handler moves a query widget to the front when it is clicked
 */
public class ToFrontEventHandler extends PBasicInputEventHandler  implements CheckConsumedInputEventHandler {

    
    public void mousePressed(PInputEvent event) {
        
        // If there is a query widget under the pointer, bring it to the front
        if ( event.getClickCount() == 1 ) {
            LinkedHashSet<Class> objectPreference = new LinkedHashSet<Class>();
            objectPreference.add(QueryWidget.class);
            
            Widget preferredObj = Widget.findPreferencialObject((event.getCamera().pick(
                    event.getCanvasPosition().getX(),
                    event.getCanvasPosition().getY(),
                    1)).getNodeStackReference(),
                    objectPreference);

            if (preferredObj != null) {
                ((QueryWidget)preferredObj).moveToFront();
            }
                   
        }
    }
    
    public boolean eventProcessed(PInputEvent event, int type) {
        processEvent(event,type);
        // This handler never consumes events
        return false;
    }
    
}
